﻿/*!	r_alloc_base.h
	@brief	アロケータ基底
Copyright (c) 2009 Yuya Yamaguchi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#ifndef _R_ALLOC_BASE_H_
#define _R_ALLOC_BASE_H_

#include "../r_type.h"


//! アロケータ基底
/*! アロケータはシリアライズ対象外となります
*/
class cRAllocBase
{
public:
	//! コンストラクタ
	/*!
	@param	_name		[in]	アロケータの名前を示すポインタ
	@param	_totalSize	[in]	このアロケータで管理するサイズ
	@param	_align		[in]	アライメント
	*/
	cRAllocBase ( const r_cstr _name, r_size _totalSize, r_si32 _align );
	//! デストラクタ
	virtual ~cRAllocBase ( void );
public:
	//! メモリ確保
	/*!
	@param	size	[in]	確保するメモリのサイズ
	@retval	void*	確保されたメモリの先頭ポインタ
	*/
	virtual	void*		malloc ( r_size size ) = 0;
	//! メモリ再確保
	/*!
	@param	pt		[in]	確保済みのメモリ領域の先頭ポインタ
	@param	size	[in]	再確保するメモリのサイズ
	@retval	void*	確保されたメモリの先頭ポインタ
	*/
	virtual void*		realloc ( void *pt, r_size size ) = 0;
	//! メモリ開放
	/*!
	@param	pointer	[in]
	*/
	virtual	void		free ( void *pointer ) = 0;
public:
	//! アロケータの名前の取得
	/*!
	*/
	const r_cstr		getName() const;
	//! 利用可能サイズの取得
	/*!
	*/
	r_size				getTotalSize() const;
	//! アライン境界の取得
	/*!
	*/
	r_si32				getAlign() const;
	//! 現在のアロケート回数
	/*!
	*/
	r_si32				getNumAlloc() const;
	//! 現在のアロケート済みサイズ
	/*!
	*/
	r_si32				getSumAlloc() const;
protected:
	//! 名前
	const r_cstr		name;
	//! 利用可能なメモリ総量
	r_size				totalSize;
	//! アライン
	r_si32				align;
	//! 合計アロケート回数
	r_si32				numAlloc;
	//! 合計アロケート済みサイズ
	r_size				sumAlloc;
private:
};


#endif // _R_ALLOC_BASE_H_
